<meta charset="UTF-8">
<h1>easy-yapi</h1>
<br/>
<a href="https://github.com/tangcent/easy-yapi">GitHub</a> |
<a href="https://github.com/tangcent/easy-yapi/issues">Issues</a> |
<a href="https://easyyapi.com">Guide</a>
<br/>
<br/>
<b>Help you export API to yapi/postman/markdown</b>
<br/>

<ul>
    <li>Parse API documents based on javadoc & KDoc & ScalaDoc</li>
    <li>Note: It's possible to generate a comprehensive API document with minimal code modification.</li>
    <li>However, specific requirements might necessitate additional comments/annotations.
        To minimize code intrusion, you can employ flexible configuration rules tailored to your project's needs.
    </li>
</ul>
<br/>
<b> For more details, refer to the <a href="[https://easyyapi.com ↗](https://easyyapi.com)">Guide</a></b>

<ul>How to Export API to Yapi/Postman/Markdown:
    <p>
        In your project, open the file containing the <code>API</code> or select the desired file or folder in the IDE's
        left project file area.
    </p>
    <p>
        Use the shortcut <kbd>Alt</kbd> <kbd>Shift</kbd> <kbd>E</kbd> (windows) / <kbd>Ctrl</kbd> <kbd>E</kbd> (mac).
        Then, select the APIs you want to export, select the export channel <code>Yapi/Markdown/Postman</code>,
        and click the [✔] button or press Enter to complete the export.
    </p>
</ul>
<br/>
<p>
    <b>Note:</b> If the shortcut does not work, check for shortcut conflicts.
    You can modify the shortcut in <kbd>Preferences(Settings)</kbd> > <kbd>KeyMap</kbd>.
</p>
<br/>